-
Notifications
You must be signed in to change notification settings - Fork 306
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Strawman API Docs #1419
base: main
Are you sure you want to change the base?
Strawman API Docs #1419
Conversation
@meeseeksdev tag enhancement |
Awww, sorry bollwyvl you do not seem to be allowed to do that, please ask a repository maintainer. |
I knew it! All the bots are just more Steves! ❤️ 🎸 |
Locally, it looks like the 1.4mb slug of JS doubles the size of the wheel:
That's... not actually as bad as I expected for a full, robust, and extremely useful app, but still pretty heavy. It's possible that size could be further tightened up, but would likely require hundreds of megabytes of I'll mark this ready for review, but am still not convinced it should be added to core, and will let others weigh in before going any further. For example:
But really... extensions should be able to extend the spec via the existing All of this points to complexity that would be better handled in an extension, and even if
|
During the jupyter servers and kernels call last week, @vidartf raised the question of exposing additional openapi specs. This points to another potential use case, where an extension (or otherwise wrapped service, e.g. via
This could probably be deep linked via some GET param, e.g. This doesn't handle the case where an extension overloads an existing route (perhaps by adding some new fields or metadata). Another thought: currently |
references
/api
with interactive docs #1418code changes
package.json
/api/apidocs
endpointalternatives
redoc
per Add an HTML endpoint for/api
with interactive docs #1418 (comment)node_modules
/api
(or evenapi/spec.yaml?docs
) would be strictly better, but these both seemed finicky to sniff based on headers, and sometimes be static file or JSON or whatever, and probably not worth the hasslespec.yaml
assessment
jupyter_server[apidocs]
would probably be pretty goodscreens
🔔 @Zsailer @tonyfast